Interface CiscoDevice

All Superinterfaces:
Device, IPCObject
All Known Subinterfaces:
ASA, Router, WirelessRouter
All Known Implementing Classes:
ASAImpl, CiscoDeviceImpl, RouterImpl, WirelessRouterImpl

public interface CiscoDevice extends Device
Information provided by the PKI file:

    \class CiscoDevice
    
    \brief CiscoDevice is any Cisco-branded device with a terminal line.
    
    \example network().getDevice("Router0")
    
Author:
Auto-generated
  • Method Details

    • setHostName

      void setHostName(String hostname)
      Information provided by the PKI file:
      
          \brief Sets the hostname of this device with the specified string.
          
          \param string, the hostname string.
          
              
      Parameters:
      hostname - Takes in a parameter of hostname
    • getHostName

      String getHostName()
      Information provided by the PKI file:
      
          \brief Returns the hostname of this device.
          
          \return string, the hostname of this device.
          
              
      Returns:
      String Returns a String
    • setEnableSecret

      void setEnableSecret(String password)
      Information provided by the PKI file:
      
          \brief Sets the encrypted enable secret password with the specified string.
          
          \param string, the encrypted secret password string.
          
              
      Parameters:
      password - Takes in a parameter of password
    • getEnableSecret

      String getEnableSecret()
      Information provided by the PKI file:
      
          \brief Returns the encrypted enable secret string.
          
          \return string, the encrypted enable secret string.
          
              
      Returns:
      String Returns a String
    • setEnablePassword

      void setEnablePassword(String password, int level)
      Information provided by the PKI file:
      
          \brief Sets the enable password.
          
          \param password, the clear text password string.
          
          \param level, the level must be 7 or 0. 7 is hidden.
          
              
      Parameters:
      password - Takes in a parameter of password
      level - Takes in a parameter of level
    • getEnablePassword

      String getEnablePassword()
      Information provided by the PKI file:
      
          \brief Returns the enable password.
          
          \return string, the enable password.
          
              
      Returns:
      String Returns a String
    • setStartupFile

      void setStartupFile(String str)
      Information provided by the PKI file:
      
          \brief Sets the startup file to the specified file.
          
          \param str, the filename of the config file.
          
              
      Parameters:
      str - Takes in a parameter of str
    • getStartupFile

      List<String> getStartupFile()
      Information provided by the PKI file:
      
          \brief Returns the contents of the current startup file.
          
          \return vector<string>, the contents of the current startup file.
          
              
      Returns:
      List<String> Returns a List<String>
    • addBootSystem

      boolean addBootSystem(String name)
      Information provided by the PKI file:
      
          \brief Modifies the system parameters to add a particular boot system image.
          
          \param name, the boot system name.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      boolean Returns a boolean
    • removeBootSystem

      boolean removeBootSystem(String name)
      Information provided by the PKI file:
      
          \brief Removes the specified boot system from this device.
          
          \param name, the boot system name.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      boolean Returns a boolean
    • removeAllBootSystem

      void removeAllBootSystem()
      Information provided by the PKI file:
      
          \brief Removes all boot system images from this device.
          
              
    • getBootSystems

      List<BootSystemEntry> getBootSystems()
      Information provided by the PKI file:
      
          \brief Returns the list of current boot system images.
          
          \return vector<string>, the list of current boot system images.
          
              
      Returns:
      List<BootSystemEntry> Returns a List<BootSystemEntry>
    • getConfigRegister

      Short getConfigRegister()
      Information provided by the PKI file:
      
          \brief Returns the current config register.
          
          \return short, the current config register.
          
              
      Returns:
      Short Returns a Short
    • setNextConfigRegister

      void setNextConfigRegister(Short in_register)
      Information provided by the PKI file:
      
          \brief Sets the next config register.
          
          \param in_register, the next config register.
          
              
      Parameters:
      in_register - Takes in a parameter of in_register
    • getNextConfigRegister

      Short getNextConfigRegister()
      Information provided by the PKI file:
      
          \brief Returns the next config register.
          
          \return short, the next config register.
          
              
      Returns:
      Short Returns a Short
    • setBannerMotd

      void setBannerMotd(String banner)
      Information provided by the PKI file:
      
          \brief Sets the message of the day banner when the device boots.
          
          \param banner, the message of the day.
          
              
      Parameters:
      banner - Takes in a parameter of banner
    • getBannerMotd

      String getBannerMotd()
      Information provided by the PKI file:
      
          \brief Returns the message of the day banner.
          
          \return string, the message of the day.
          
              
      Returns:
      String Returns a String
    • setTimeZone

      void setTimeZone(String timeZone, Short hourOffset, Short minOffset)
      Information provided by the PKI file:
      
          \brief Sets the timezone for this device.
          
          \param timeZone, the timezone string.
          \param hourOffset, the hours offset from UTC.
          \param minOffset, the minutes offset from UTC.
          
              
      Parameters:
      timeZone - Takes in a parameter of timeZone
      hourOffset - Takes in a parameter of hourOffset
      minOffset - Takes in a parameter of minOffset
    • getTimeZone

      String getTimeZone()
      Information provided by the PKI file:
      
          \brief Returns the timezone of this device.
          
          \return string, the timezone of this device.
          
              
      Returns:
      String Returns a String
    • getBia

      MACAddress getBia()
      Information provided by the PKI file:
      
          \brief Returns the burned-in address of this device.
          
          \return mac, the burned-in address of this device.
          
              
      Returns:
      MACAddress Returns a MACAddress
    • setServicePasswordEncryption

      void setServicePasswordEncryption(boolean bEnable)
      Information provided by the PKI file:
      
          \brief Enables or disables service password encryption.
          
          \param bEnable, true to enable service password encryption, false to disable it.
          
              
      Parameters:
      bEnable - Takes in a parameter of bEnable
    • getServicePasswordEncryption

      boolean getServicePasswordEncryption()
      Information provided by the PKI file:
      
          \brief Returns true if service password encryption is enabled, otherwise false.
          
          \return bool, true if service password encryption is enabled, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getConsole

      Port getConsole()
      Information provided by the PKI file:
      
          \brief Returns the console port of this device.
          
          \return Port, the console port object.
          
              
      Returns:
      Port Returns a Port
    • getConsoleLine

      TerminalLine getConsoleLine()
      Information provided by the PKI file:
      
          \brief Returns the console line of this device.
          
          \return TerminalLine, the console line TerminalLine object.
          
              
      Returns:
      TerminalLine Returns a TerminalLine
    • getVtyLine

      TerminalLine getVtyLine(int num)
      Information provided by the PKI file:
      
          \brief Returns the vty line specified by num.
          
          \param num, the vty line number of interest.
          
          \return TerminalLine, the vty line TerminalLine object.
          
              
      Parameters:
      num - Takes in a parameter of num
      Returns:
      TerminalLine Returns a TerminalLine
    • getLine

      TerminalLine getLine(int num)
      Information provided by the PKI file:
      
          \brief Returns the line specified by num.
          
          \param num, the line number of interest.
          
          \return TerminalLine, the line TerminalLine object.
          
              
      Parameters:
      num - Takes in a parameter of num
      Returns:
      TerminalLine Returns a TerminalLine
    • getIpcTerminalLine

      TerminalLine getIpcTerminalLine()
      Information provided by the PKI file:
      
          \brief Returns the IPC terminal line of this device.
          
          \return TerminalLine, the IPC TerminalLine object.
          
              
      Returns:
      TerminalLine Returns a TerminalLine
    • enterCommand

      Pair<CommandStatus,String> enterCommand(String commandStr, String modeStr)
      Information provided by the PKI file:
      
          \brief Enters the specified command in the specified mode to the terminal.
          
          \param commandStr   the command string.
          \param modeStr              the mode. Valid modes: user, enable, global.
          If blank, the command string will be entered into the current mode.
          
          \return pair<CommandStatus,  the status of the command entry.
          Valid command statuses:     eStatusOk = 0,
          eErrorAmbiguous = 1,
          eErrorInvalid = 2,
          eErrorIncomplete = 3,
          eErrorNotImplemented = 4
          
              
      Parameters:
      commandStr - Takes in a parameter of commandStr
      modeStr - Takes in a parameter of modeStr
      Returns:
      Pair<CommandStatus, String> Returns a Pair<CommandStatus, String>
    • isBooting

      boolean isBooting()
      Information provided by the PKI file:
      
          \brief Checks whether the device is currently booting
          
              
      Returns:
      boolean Returns a boolean
    • skipBoot

      void skipBoot()
      Information provided by the PKI file:
      
          \brief Skips the booting process.
          
              
    • setFtpUsername

      void setFtpUsername(String username)
      Information provided by the PKI file:
      
          \brief Sets the FTP username for the device.
          
          \param username, the desired FTP username for this device.
          
              
      Parameters:
      username - Takes in a parameter of username
    • setFtpPasswd

      void setFtpPasswd(String passwd, int uType)
      Information provided by the PKI file:
      
          \brief Sets the FTP password for the device.
          
          \param passwd, the desired FTP password for this device.
          
          \param uType, whether the password is encrypted or not. 7 is encryped or 0 is unencrypted.
          
              
      Parameters:
      passwd - Takes in a parameter of passwd
      uType - Takes in a parameter of uType
    • getFtpUsername

      String getFtpUsername()
      Information provided by the PKI file:
      
          \brief Returns the FTP username for the device.
          
          \return string, the FTP username for this device.
          
              
      Returns:
      String Returns a String
    • getFtpPasswd

      String getFtpPasswd()
      Information provided by the PKI file:
      
          \brief Returns the FTP password for the device.
          
          \return string, the FTP password for this device.
          
              
      Returns:
      String Returns a String
    • clearFtpUsername

      void clearFtpUsername()
      Information provided by the PKI file:
      
          \brief Clears the current FTP username.
          
              
    • clearFtpPasswd

      void clearFtpPasswd()
      Information provided by the PKI file:
      
          \brief Clears the current FTP password.
          
              
    • getUserPassCount

      int getUserPassCount()
      Information provided by the PKI file:
      
          \brief Returns the number of authenticated users.
          
          \return int, the number of authenticated users.
          
              
      Returns:
      int Returns a int
    • addUserPassEntry

      void addUserPassEntry(String username, String password, int type)
      Information provided by the PKI file:
      
          \brief Adds an authenticated user with the specified username, password, and type.
          
          \param username, the username for the authenticated user.
          \param password, the password for the authenticated user.
          \param type, the type for the user. The default is type 0.
          
              
      Parameters:
      username - Takes in a parameter of username
      password - Takes in a parameter of password
      type - Takes in a parameter of type
    • removeUserPassEntry

      void removeUserPassEntry(String username)
      Information provided by the PKI file:
      
          \brief Removes the authenticated user with the specified username.
          
          \param username, the username of the authenticated user of interest.
          
              
      Parameters:
      username - Takes in a parameter of username
    • getUserEntryAt

      String getUserEntryAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the username of the authenticated user at the specified index.
          
          \param index, the index of the authenticated user of interest.
          
          \return string, the username of the authenticated user at the specified index.
          
              
      Parameters:
      index - Takes in a parameter of index
      Returns:
      String Returns a String
    • removeUserPassAt

      void removeUserPassAt(int index)
      Information provided by the PKI file:
      
          \brief Removes the username of the authenticated user at the specified index.
          
          \param index, the index of the authenticated user of interest.
          
              
      Parameters:
      index - Takes in a parameter of index
    • isUserExist

      boolean isUserExist(String username)
      Information provided by the PKI file:
      
          \brief Returns true if the specified authenticated user exists, otherwise false.
          
          /param username, the username of the authenticated user of interest.
          
          \return bool, true if the specified authenticated user exists, otherwise false.
          
              
      Parameters:
      username - Takes in a parameter of username
      Returns:
      boolean Returns a boolean